Skip to content

Update README, homepage, and quickstart docs#104

Merged
lovelydinosaur merged 5 commits intodevfrom
quickstart-docs
Jun 17, 2025
Merged

Update README, homepage, and quickstart docs#104
lovelydinosaur merged 5 commits intodevfrom
quickstart-docs

Conversation

@lovelydinosaur
Copy link
Contributor

@lovelydinosaur lovelydinosaur commented Jun 16, 2025 •
edited
Loading

A complete HTTP framework for Python.

Installation...

$ pip install git+https://github.com/encode/httpnext.git

Making requests as a client...

>>> r = httpx.get('https://www.example.org/')
>>> r
<Response [200 OK]>
>>> r.status_code
200
>>> r.headers['content-type']
'text/html; charset=UTF-8'
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'

Serving responses as the server...

>>> def hello_world(request):
...     content = httpx.HTML('<html><body>hello, world.</body></html>')
...     return httpx.Response(code=200, content=content)
...
>>> with httpx.serve_http(hello_world) as server:
...     print(f"Serving on {server.url} (Press CTRL+C to quit)")
...     server.wait()
Serving on http://127.0.0.1:8080/ (Press CTRL+C to quit)

Features include...

  • Available in either sync or async flavours.
  • A comprehensive set of HTTP components, with immutability throughout.
  • A low complexity stack, with no required dependencies.
  • Type annotation throughout.

Documentation

The httpx 1.0 design proposal is now available.

Collaboration

The design repository for this work is currently private. We are looking towards a development model that encourages a calm focused working environment, and are currently taking a little time to work through expectations & boundaries for contributions to the codebase.

Background

If you've been working with 0.x versions of HTTPX you'll notice significant API differences.

Version 1.0 provides a much more tightly constrained API. It has a lighter installation footprint, far more obvious type annotations, and a lower overall complexity.

For example:

@lovelydinosaur lovelydinosaur merged commit 1e94021 into dev Jun 17, 2025
4 checks passed
@lovelydinosaur lovelydinosaur deleted the quickstart-docs branch June 17, 2025 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@lovelydinosaur